home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / src / exampleCode / irix / scripts / rcs / README < prev    next >
Encoding:
Text File  |  1994-08-02  |  7.5 KB  |  270 lines
  1.  
  2.  
  3.           ~4Dgifts/toolbox/src/exampleCode/irix/scripts/rcs README
  4.  
  5.  
  6.       a directory of scripts written to facilitate manipulation of source 
  7.       trees employing RCS
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14. Comprcs         Compare RCS files with non-RCS files in another directory.
  15.                 Performs an rcsdiff on all files in the local RCS 
  16.         directory with files in the directory specified.  If no 
  17.         directory specified, it will check if an environment 
  18.         variable COMPRDIR exists and use the directory there.  
  19.         If neither exists, assumes the local directory.
  20.  
  21.                 If a file is provided, checks only this file.
  22.  
  23.                 Synopsis:
  24.                         Comprcs [-d <dir>] [-<opts>] [<file>...]
  25.  
  26.         Use:
  27.             The purpose of this routine is to check if
  28.             another directory contains sources that are
  29.             different from the files already checked in.
  30.             This could be used when copying a new source
  31.             tree off of the internet to find out if any of
  32.             the source files have changed.
  33.  
  34.  
  35.  
  36.  
  37. Delrcs          Delete all the files that exist in RCS.
  38.  
  39.         Synopsis:
  40.             Delrcs
  41.  
  42.         Use:
  43.             The purpose of this routine is to delete all
  44.             the files that have a respective RCS file.
  45.             Usually, this is performed *after* doing a
  46.             'check' command and making sure that all files
  47.             that have been checked out and locked have
  48.             been checked back in.  What is left in the
  49.             directory are all the files that have never
  50.             been checked in and have no respective RCS
  51.             file.  This can be real useful when a
  52.             directory has a lot of source files and it is
  53.             hard to determine which files are new.
  54.  
  55.  
  56.  
  57.  
  58. DiffRCS         This script will perform an rcsdiff on each file found
  59.         in the current directory (ignoring *~, *.o and *.out 
  60.         files) and just list those files that are different or
  61.         not checked in (don't have a respective RCS file).
  62.  
  63.         Use:
  64.             Similar use as for Comprcs.
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Lscoed          Provide a list of all files that are checked out of RCS.
  71.  
  72.         Use:
  73.             This is similar to the 'check' command except
  74.             that it will print a list of all files checked
  75.             out whether locked or not.
  76.  
  77.  
  78.  
  79.  
  80.  
  81. Makercsrev      Make a revision of every RCS file.  If there is an
  82.         environment variable RCSOPTS, it will use options
  83.         provided with this variable when checking out the
  84.         revision.  Also, if there is a ./.rcsopts file, it
  85.         will search for a line beginning with 'co ' and use
  86.         the options provided on the rest of the line when
  87.         checking out the specified revision.
  88.  
  89.         Synopsis:
  90.             Makercsrev <rev#>
  91.  
  92.         Use:
  93.             Checks out every RCS file and checks it back
  94.             in with the revision specified, thus creating
  95.             a new revision.  Useful for changing the major
  96.             revision number so that checking out '-r4',
  97.             for example, will check out the latest
  98.             revision of all the files.  Also useful for
  99.             checking out an older revision and making it
  100.             the latest revision.  This might be necessary
  101.             if it is found that a previous revision is
  102.             better than the updated revision and we
  103.             basically want to return to the previous
  104.             revision without having to "out-date" all the
  105.             intermediate revisions.
  106.  
  107.  
  108.  
  109.  
  110.  
  111. Setrcsname    Sets the name for a revision of every RCS file.
  112.  
  113.         Synopsis:
  114.             Setrcsname -n <name> [-l] [file-list]
  115.             Setrcsname -n <name>:<rev> [-m] [file-list]
  116.             Setrcsname -N <name> [-l] [file-list]
  117.             Setrcsname -N <name>:<rev> [-m] [file-list]
  118.  
  119.         Use:
  120.             In all forms, if 'file-list' is not provided,
  121.             all the files in the RCS directory are
  122.             affected.
  123.  
  124.             In the first form, the symbolic name <name> is
  125.             deleted from the RCS files.  If the '-l' flag
  126.             is provided, the last revision of all the RCS
  127.             files has its last component removed and the
  128.             <name> is defined to be this revision.  For
  129.             example, in a particular RCS file, if the last
  130.             revision is 2.34, the symbolic name <name>
  131.             will be set to '2'.  Thus, if the file is
  132.             checked out with the name <name>, the last
  133.             revision '2' will be checked out (which could
  134.             be 2.35, 2.36, ..., depending on what the last
  135.             revision is when the file is checked out).  If
  136.             the symbolic name <name> already exists when
  137.             Setrcsname is run, an error will be generated
  138.             and the name will not be set.
  139.  
  140.             In the second form, the symbolic name <name>
  141.             is set to revision <rev> in all the RCS files.
  142.             If the '-m' flag is provided, the name will be
  143.             set *only if* the revision actually exists.
  144.             If the symbolic name <name> already exists, an
  145.             error will be generated and the name will not
  146.             be set.
  147.  
  148.             The third and fourth forms are identical to
  149.             the first and second forms, respectively,
  150.             except that if the symbolic name already
  151.             exists, it will be changed to the new
  152.             revision.
  153.  
  154.  
  155.  
  156.  
  157.  
  158. Setrcsstate    Sets a state for a revision of every RCS file.
  159.  
  160.         Synopsis:
  161.             Setrcsstate <state>
  162.             Setrcsstate [-m] <state>:<rev>
  163.  
  164.         -m      Set state only if revision exists.
  165.  
  166.         Use:
  167.                       This script sets the state for a revison of all
  168.             RCS files found in the RCS subdirectory.
  169.  
  170.                       In the first form, the state of the last
  171.             branch of every file found in the RCS
  172.             subdirectory is set to <state>.
  173.  
  174.                       In the second form, the specified revision is
  175.             set to <state>.
  176.  
  177.  
  178.  
  179.  
  180.  
  181. ci-script    Performs a ci on the file(s) requested.
  182.  
  183.         Synopsis:
  184.             alias ci ci-script
  185.             ...
  186.             ci <somefile>
  187.  
  188.         Use:
  189.             Provides added automatic functions when a ci
  190.             is performed.  These functions include:
  191.  
  192.             1. Always performs default options $opt
  193.                (defined in this script).  This allows the
  194.                user to define ci options that should
  195.                always be set.
  196.  
  197.             2. Performs options found in environment
  198.                variable RCSOPTS.  If there is an
  199.                environment variable RCSOPTS set, it
  200.                appends these options to the default set.
  201.  
  202.             3. Performs options found in file ./.rcsopts.
  203.                If there is a file in the current directory
  204.                named .rcsopts, the checks if there is a
  205.                line beginning with 'ci' in it.  If there
  206.                is, it assumes the rest of the line are
  207.                options that are to be appended to the ones
  208.                defined so far when doing the ci.  Note,
  209.                this allows the user to define specific
  210.                options to be performed in different
  211.                directories.
  212.  
  213.             4. Passes arguments from command line to ci.
  214.                Any other options or arguments on the
  215.                command line are passed to ci.
  216.  
  217.             Note, if there are conflicting options in one
  218.             of the above sets, it chooses the correct set
  219.             of options to actually use.
  220.  
  221.  
  222.  
  223.  
  224.  
  225. ciAll        Script that will check in all the files found in the
  226.         current directory.
  227.  
  228.         Synopsis:
  229.             ciAll [<opts>]
  230.  
  231.         <opts>    Any additional options to be provided to the
  232.             ci command.
  233.  
  234.         Uses:
  235.             Similar to performing a 'ci <opts> *' command
  236.             except this script is smart enough to skip
  237.             directories and provides the user with an
  238.             option of checking in files that have never
  239.             been checked in before.  For example, in a
  240.             directory where there are object files and
  241.             executables, the user is prompted as to
  242.             whether to check in the object files (since
  243.             they have never been checked in) and the user
  244.             can choose y/n to have the file checked in or
  245.             not.
  246.  
  247.             Also, if the file has never been checked in
  248.             and the user elects to have it checked in,
  249.             this script will print the first 30 lines of
  250.             the file to help the user determine what to
  251.             write as a description for the file when ci
  252.             asks for it.
  253.  
  254.  
  255.  
  256.  
  257.  
  258. co-script    Similar to ci-script except should be aliased to the
  259.         'co' command.
  260.  
  261.  
  262.  
  263.  
  264.  
  265. col-script    Similar to co-script except could be aliased to the
  266.         'col' command.  This would be identical to 'co -l'
  267.         except it allows the user the ability to have
  268.         different options passed to co when the file is to be
  269.         checked out and locked.
  270.